home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / prgtools / gnustuff / tos / othergnu / texinf31.zoo / texinfo-3.1 / makeinfo / makeinfo.info < prev    next >
Encoding:
GNU Info File  |  1993-06-01  |  8.1 KB  |  225 lines
  1. This is Info file makeinfo.info, produced by Makeinfo-1.55 from the
  2. input file makeinfo.texi.
  3.  
  4. This file is an extract from the `Texinfo' manual.
  5. It documents `makeinfo', a program that converts Texinfo files into
  6. Info files.
  7.  
  8. Copyright (C) 1992, 1993 Free Software Foundation, Inc.
  9.  
  10. Permission is granted to make and distribute verbatim copies of this
  11. manual provided the copyright notice and this permission notice are
  12. preserved on all copies.
  13.  
  14. Permission is granted to copy and distribute modified versions of this
  15. manual under the conditions for verbatim copying, provided that the
  16. entire resulting derived work is distributed under the terms of a
  17. permission notice identical to this one.
  18.  
  19. Permission is granted to copy and distribute translations of this manual
  20. into another language, under the above conditions for modified versions,
  21. except that this permission notice may be stated in a translation
  22. approved by the Free Software Foundation.
  23.  
  25. File: makeinfo.info,  Node: Top,  Next: What is makeinfo,  Prev: (dir),  Up: (dir)
  26.  
  27. `makeinfo'
  28. **********
  29.  
  30. This file documents the use of the `makeinfo' program, versions 1.51
  31. and later.  It is an extract from the `Texinfo' manual.
  32.  
  33. * Menu:
  34.  
  35. * What is makeinfo::
  36.  
  38. File: makeinfo.info,  Node: What is makeinfo,  Prev: Top,  Up: Top
  39.  
  40. What is `makeinfo'?
  41. *******************
  42.  
  43. `makeinfo' is a program for converting "Texinfo" files into "Info"
  44. files.  Texinfo is a documentation system that uses a single source
  45. file to produce both on-line information and printed output.
  46.  
  47. You can read the on-line information using Info; type `info' to learn
  48. about Info.  *Note Texinfo: (texinfo.texi)Top, to learn about the
  49. Texinfo documentation system.
  50.  
  51. * Menu:
  52.  
  53. * Formatting Control::
  54. * Options::
  55. * Pointer Validation::
  56.  
  58. File: makeinfo.info,  Node: Formatting Control,  Next: Options,  Up: What is makeinfo
  59.  
  60. Controlling Paragraph Formats
  61. =============================
  62.  
  63. In general, `makeinfo' "fills" the paragraphs that it outputs to an
  64. Info file.  Filling is the process of breaking and connecting lines so
  65. that lines are the same length as or shorter than the number specified
  66. as the fill column.  Lines are broken between words.  With `makeinfo',
  67. you can control:
  68.  
  69.    * The width of each paragraph (the "fill-column").
  70.  
  71.    * The amount of indentation that the first line of each paragraph
  72.      receives (the "paragraph-indentation").
  73.  
  75. File: makeinfo.info,  Node: Options,  Next: Pointer Validation,  Prev: Formatting Control,  Up: What is makeinfo
  76.  
  77. Command Line Options
  78. ====================
  79.  
  80. The following command line options are available for `makeinfo'.
  81.  
  82. `-D VAR'
  83.      Cause VAR to be defined.  This is equivalent to `@set VAR' in the
  84.      Texinfo file.
  85.  
  86. `--error-limit LIMIT'
  87.      Set the maximum number of errors that `makeinfo' will report
  88.      before exiting (on the assumption that continuing would be
  89.      useless).  The default number of errors that can be reported before
  90.      `makeinfo' gives up is 100.
  91.  
  92. `--fill-column WIDTH'
  93.      Specify the maximum number of columns in a line; this is the
  94.      right-hand edge of a line.  Paragraphs that are filled will be
  95.      filled to this width.  The default value for `fill-column' is 72.
  96.  
  97. `--footnote-style STYLE'
  98.      Set the footnote style to STYLE, either `end' for the end node
  99.      style or `separate' for the separate node style.  The value set by
  100.      this option overrides the value set in a Texinfo file by an
  101.      `@footnotestyle' command.  When the footnote style is `separate',
  102.      `makeinfo' makes a new node containing the footnotes found in the
  103.      current node.  When the footnote style is `end', `makeinfo' places
  104.      the footnote references at the end of the current node.
  105.  
  106. `-I DIR'
  107.      Add `dir' to the directory search list for finding files that are
  108.      included using the `@include' command.  By default, `makeinfo'
  109.      searches only the current directory.
  110.  
  111. `--no-headers'
  112.      Do not include menus or node lines in the output.  This results in
  113.      an ASCII file that you cannot read in Info since it does not
  114.      contain the requisite nodes or menus; but you can print such a
  115.      file in a single, typewriter-like font and produce acceptable
  116.      output.
  117.  
  118. `--no-split'
  119.      Suppress the splitting stage of `makeinfo'.  Normally, large
  120.      output files (where the size is greater than 70k bytes) are split
  121.      into smaller subfiles, each one approximately 50k bytes.  If you
  122.      specify `--no-split', `makeinfo' will not split up the output file.
  123.  
  124. `--no-pointer-validate'
  125. `--no-validate'
  126.      Suppress the pointer-validation phase of `makeinfo'.  Normally,
  127.      after a Texinfo file is processed, some consistency checks are
  128.      made to ensure that cross references can be resolved, etc.  *Note
  129.      Pointer Validation::.
  130.  
  131. `--no-warn'
  132.      Suppress the output of warning messages.  This does *not* suppress
  133.      the output of error messages, only warnings.  You might want this
  134.      if the file you are creating has examples of Texinfo cross
  135.      references within it, and the nodes that are referenced do not
  136.      actually exist.
  137.  
  138. `--no-number-footnotes'
  139.      Supress automatic footnote numbering.  By default, `makeinfo'
  140.      numbers each footnote sequentially in a single node, resetting the
  141.      current footnote number to 1 at the start of each node.
  142.  
  143. `--output FILE'
  144. `-o FILE'
  145.      Specify that the output should be directed to FILE and not to the
  146.      file name specified in the `@setfilename' command found in the
  147.      Texinfo source.  FILE can be the special token `-', which specifies
  148.      standard output.
  149.  
  150. `--paragraph-indent INDENT'
  151.      Set the paragraph indentation style to INDENT.  The value set by
  152.      this option overrides the value set in a Texinfo file by an
  153.      `@paragraphindent' command.  The value of INDENT is interpreted as
  154.      follows:
  155.  
  156.         * If the value of INDENT is `asis', do not change the existing
  157.           indentation at the starts of paragraphs.
  158.  
  159.         * If the value of INDENT is zero, delete any existing
  160.           indentation.
  161.  
  162.         * If the value of INDENT is greater than zero, indent each
  163.           paragraph by that number of spaces.
  164.  
  165. `--reference-limit LIMIT'
  166.      Set the value of the number of references to a node that
  167.      `makeinfo' will make without reporting a warning.  If a node has
  168.      more than this number of references in it, `makeinfo' will make the
  169.      references but also report a warning.
  170.  
  171. `-U VAR'
  172.      Cause VAR to be undefined.  This is equivalent to `@clear VAR' in
  173.      the Texinfo file.
  174.  
  175. `--verbose'
  176.      Cause `makeinfo' to display messages saying what it is doing.
  177.      Normally, `makeinfo' only outputs messages if there are errors or
  178.      warnings.
  179.  
  180. `--version'
  181.      Report the version number of this copy of `makeinfo'.
  182.  
  184. File: makeinfo.info,  Node: Pointer Validation,  Prev: Options,  Up: What is makeinfo
  185.  
  186. Pointer Validation
  187. ==================
  188.  
  189. If you do not suppress pointer-validation (by using the
  190. `--no-pointer-validation' option), `makeinfo' will check the validity
  191. of the final Info file.  Mostly, this means ensuring that nodes you
  192. have referenced really exist.  Here is a complete list of what is
  193. checked:
  194.  
  195.   1. If a `Next', `Previous', or `Up' node reference is a reference to a
  196.      node in the current file and is not an external reference such as
  197.      to `(dir)', then the referenced node must exist.
  198.  
  199.   2. In every node, if the `Previous' node is different from the `Up'
  200.      node, then the `Previous' node must also be pointed to by a `Next'
  201.      node.
  202.  
  203.   3. Every node except the `Top' node must have an `Up' pointer.
  204.  
  205.   4. The node referenced by an `Up' pointer must contain a reference to
  206.      the current node in some manner other than through a `Next'
  207.      reference.  This includes menu entries and cross references.
  208.  
  209.   5. If the `Next' reference of a node is not the same as the `Next'
  210.      reference of the `Up' reference, then the node referenced by the
  211.      `Next' pointer must have a `Previous' pointer that points back to
  212.      the current node.  This rule allows the last node in a section to
  213.      point to the first node of the next chapter.
  214.  
  215.  
  217. Tag Table:
  218. Node: Top949
  219. Node: What is makeinfo1215
  220. Node: Formatting Control1758
  221. Node: Options2377
  222. Node: Pointer Validation6743
  224. End Tag Table
  225.